home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 7 / Apprentice-Release7.iso / Environments / Clean 1.2.4 / StdEnv / StdFile.dcl < prev    next >
Encoding:
Text File  |  1996-12-23  |  4.8 KB  |  132 lines  |  [TEXT/3PRM]
  1. system module StdFile
  2.  
  3. // ****************************************************************************************
  4. //    Concurrent Clean Standard Library Module Version 1.1
  5. //    Copyright 1995 University of Nijmegen
  6. // ****************************************************************************************
  7.  
  8. //    File modes synonyms
  9.  
  10. FReadText    :== 0    //    Read from a text file
  11. FWriteText    :== 1    //    Write to a text file
  12. FAppendText    :== 2    //    Append to an existing text file
  13. FReadData    :== 3    //    Read from a data file
  14. FWriteData    :== 4    //    Write to a data file
  15. FAppendData    :== 5    //    Append to an existing data file
  16.  
  17. //    Seek modes synonyms
  18.  
  19. FSeekSet    :== 0    //    New position is the seek offset
  20. FSeekCur    :== 1    //    New position is the current position plus the seek offset
  21. FSeekEnd    :== 2    //    New position is the size of the file plus the seek offset
  22.  
  23. ::    *Files
  24.  
  25. //    Opening and Closing a File from the FileSystem:
  26.  
  27. openfiles    :: !*World -> (!*Files,!*World)
  28.  
  29. closefiles    :: !*Files !*World -> *World
  30.  
  31. fopen        :: !{#Char} !Int !*Files -> (!Bool,!*File,!*Files)
  32. /*    Opens a file for the first time in a certain mode (read, write or append, text or data).
  33.     The boolean output parameter reports success or failure. */
  34.  
  35. fclose        :: !*File !*Files -> (!Bool,!*Files)
  36.  
  37. freopen        :: !*File !Int -> (!Bool,!*File)
  38. /*    Re-opens an open file in a possibly different mode.
  39.     The boolean indicates whether the file was successfully closed before reopening. */
  40.  
  41. //    Reading from a File:
  42.  
  43. freadc        :: !*File -> (!Bool,!Char,!*File)
  44. /*    Reads a character from a text file or a byte from a datafile.
  45.     The boolean indicates succes or failure */
  46.  
  47. freadi        :: !*File -> (!Bool,!Int,!*File)
  48. /*    Reads an Integer from a textfile by skipping spaces, tabs and newlines and
  49.     then reading digits, which may be preceeded by a plus or minus sign.
  50.     From a datafile freadi will just read four bytes (a Clean Int). */
  51.  
  52. freadr        :: !*File -> (!Bool,!Real,!*File)
  53. /*    Reads a Real from a textfile by skipping spaces, tabs and newlines and then
  54.     reading a character representation of a Real number.
  55.     From a datafile freadr will just read eight bytes (a Clean Real). */
  56.  
  57. freads        :: ! *File !Int -> (!*{#Char},!*File)
  58. /*    Reads n characters from a text or data file, which are returned as a String.
  59.     If the file doesn't contain n characters the file will be read to the end
  60.     of the file. An empty String is returned if no characters can be read. */
  61.  
  62. freadline    :: !*File -> (!{#Char},!*File)
  63. /*    Reads a line from a textfile. (including a newline character, except for the last
  64.     line) freadline cannot be used on data files. */
  65.  
  66. //    Writing to a File:
  67.  
  68. fwritec        :: !Char !*File -> *File
  69. /*    Writes a character to a textfile.
  70.     To a datafile fwritec writes one byte (a Clean Char). */
  71.  
  72. fwritei        :: !Int !*File -> *File
  73. /*    Writes an Integer (its textual representation) to a text file.
  74.     To a datafile fwritei writes four bytes (a Clean Int). */
  75.  
  76. fwriter        :: !Real !*File -> *File
  77. /*    Writes a Real (its textual representation) to a text file.
  78.     To a datafile fwriter writes eight bytes (a Clean Real). */
  79.  
  80. fwrites        :: !{#Char} !*File -> *File
  81. /*    Writes a String to a text or data file. */
  82.  
  83. //    Testing:
  84.  
  85. fend        :: !*File -> (!Bool,!*File)
  86. /*    Tests for end-of-file. */
  87.  
  88. ferror        :: !*File -> (!Bool,!*File)
  89. /*    Has an error occurred during previous file I/O operations? */
  90.  
  91. fposition    :: !*File -> (!Int,!*File)
  92. /*    returns the current position of the file poInter as an Integer.
  93.     This position can be used later on for the fseek function. */
  94.  
  95. fseek        :: !*File !Int !Int -> (!Bool,!*File)
  96. /*    Move to a different position in the file, the first Integer argument is the offset,
  97.     the second argument is a seek mode. (see above). True is returned if successful. */
  98.  
  99. //    Predefined files.
  100.  
  101. stdio        :: !*Files -> (!*File,!*Files)
  102. /*    Open the 'Console' for reading and writing. */
  103.  
  104. stderr        :: *File
  105. /*    Open the 'Errors' file for writing only. May be opened more than once. */
  106.  
  107. //    Opening and reading Shared Files:
  108.  
  109. sfopen        :: !{#Char} !Int !*Files -> (!Bool,!File,!*Files)
  110. /*    With sfopen a file can be opened for reading more than once.
  111.     On a file opened by sfopen only the operations beginning with sf can be used.
  112.     The sf... operations work just like the corresponding f... operations.
  113.     They can't be used for files opened with fopen or freopen. */
  114.  
  115. sfreadc        :: !File -> (!Bool,!Char,!File)
  116. sfreadi        :: !File -> (!Bool,!Int,!File)
  117. sfreadr        :: !File -> (!Bool,!Real,!File)
  118. sfreads        :: !File !Int -> (!{#Char},!File)
  119. sfreadline    :: !File -> (!{#Char},!File)
  120. sfseek        :: !File !Int !Int -> (!Bool,!File)
  121.  
  122. sfend        :: !File -> Bool
  123. sfposition    :: !File -> Int
  124. /*    The functions sfend and sfposition work like fend and fposition, but don't return a
  125.     new file on which other operations can continue. They can be used for files opened
  126.     with sfopen or after fshare, and in guards for files opened with fopen or freopen. */
  127.  
  128. //    Convert a *File into:
  129.  
  130. fshare        :: !*File -> File
  131. /*    Change a file so that from now it can only be used with sf... operations. */
  132.